gridpack::bus_table::BusTable< _network > Class Template Reference

#include <bus_table.hpp>

Collaboration diagram for gridpack::bus_table::BusTable< _network >:

[legend]

List of all members.

Public Types
typedef _network	NetworkType
typedef boost::shared_ptr < NetworkType >	NetworkPtr
Public Member Functions
	BusTable (const boost::shared_ptr< _network > network)
	~BusTable (void)
bool	readTable (std::string &filename)
void	getLocalIndices (std::vector< int > &indices)
void	getTags (std::vector< std::string > &tags)
void	getValues (int idx, std::vector< double > &values)
void	getHeaders (std::vector< std::string > &headers)
int	getNumColumns ()

template<typename _network>
class gridpack::bus_table::BusTable< _network >

---

Member Typedef Documentation

template<typename _network >

typedef boost::shared_ptr<NetworkType> gridpack::bus_table::BusTable< _network >::NetworkPtr

template<typename _network >

typedef _network gridpack::bus_table::BusTable< _network >::NetworkType

---

Constructor & Destructor Documentation

template<typename _network >

gridpack::bus_table::BusTable< _network >::BusTable

(

const boost::shared_ptr< _network >

network

)

template<typename _network >

gridpack::bus_table::BusTable< _network >::~BusTable

(

void

)

---

Member Function Documentation

template<typename _network >

void gridpack::bus_table::BusTable< _network >::getHeaders

(

std::vector< std::string > &

headers

)

template<typename _network >

void gridpack::bus_table::BusTable< _network >::getLocalIndices

(

std::vector< int > &

indices

)

Return a list of local indices of all buses in the table

Parameters:

indices

array holding local indices

template<typename _network >

int gridpack::bus_table::BusTable< _network >::getNumColumns

(

)

Return the number of columns in the table

template<typename _network >

void gridpack::bus_table::BusTable< _network >::getTags

(

std::vector< std::string > &

tags

)

Return a list of tags for all objects on buses in the table

Parameters:

tags

array holding tags

template<typename _network >

void gridpack::bus_table::BusTable< _network >::getValues	(	int	idx,
		std::vector< double > &	values
	)

Return an array of values for the ith column of data in the table The vector of values can be matched to the corresponding bus object using the array returned by getLocalIndices and getTags

Parameters:

	idx	index of column of data
	values	vector containing return values.

References gridpack::parallel::Communicator::sync().

template<typename _network >

bool gridpack::bus_table::BusTable< _network >::readTable

(

std::string &

filename

)

References gridpack::utility::StringUtils::clean2Char(), gridpack::hash_distr::HashDistribution< _network, _bus_data_type, _branch_data_type >::distributeBusValues(), gridpack::parallel::Communicator::getGroup(), NUM_SLICES, gridpack::bus_table::table_t::order, gridpack::parallel::Communicator::rank(), gridpack::parallel::Communicator::sync(), gridpack::bus_table::table_t::tag, and gridpack::utility::StringUtils::trim().

---

The documentation for this class was generated from the following file:

• bus_table.hpp